1fcd35ba55b2b1694979c26ac426236353a76452
3 * Foreign file accessible through api.php requests.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
25 * Foreign file accessible through api.php requests.
26 * Very hacky and inefficient, do not use :D
28 * @ingroup FileAbstraction
30 class ForeignAPIFile
extends File
{
33 protected $repoClass = 'ForeignApiRepo';
37 * @param $repo ForeignApiRepo
41 function __construct( $title, $repo, $info, $exists = false ) {
42 parent
::__construct( $title, $repo );
45 $this->mExists
= $exists;
47 $this->assertRepoDefined();
52 * @param $repo ForeignApiRepo
53 * @return ForeignAPIFile|null
55 static function newFromTitle( Title
$title, $repo ) {
56 $data = $repo->fetchImageQuery( array(
57 'titles' => 'File:' . $title->getDBKey(),
58 'iiprop' => self
::getProps(),
59 'prop' => 'imageinfo',
60 'iimetadataversion' => MediaHandler
::getMetadataVersion()
63 $info = $repo->getImageInfo( $data );
66 $lastRedirect = isset( $data['query']['redirects'] )
67 ?
count( $data['query']['redirects'] ) - 1
69 if( $lastRedirect >= 0 ) {
70 $newtitle = Title
::newFromText( $data['query']['redirects'][$lastRedirect]['to']);
71 $img = new self( $newtitle, $repo, $info, true );
73 $img->redirectedFrom( $title->getDBkey() );
76 $img = new self( $title, $repo, $info, true );
85 * Get the property string for iiprop and aiprop
88 static function getProps() {
89 return 'timestamp|user|comment|url|size|sha1|metadata|mime';
97 public function exists() {
98 return $this->mExists
;
104 public function getPath() {
109 * @param Array $params
111 * @return bool|MediaTransformOutput
113 function transform( $params, $flags = 0 ) {
114 if( !$this->canRender() ) {
116 return parent
::transform( $params, $flags );
119 // Note, the this->canRender() check above implies
120 // that we have a handler, and it can do makeParamString.
121 $otherParams = $this->handler
->makeParamString( $params );
123 $thumbUrl = $this->repo
->getThumbUrlFromCache(
125 isset( $params['width'] ) ?
$params['width'] : -1,
126 isset( $params['height'] ) ?
$params['height'] : -1,
128 return $this->handler
->getTransform( $this, 'bogus', $thumbUrl, $params );
131 // Info we can get from API...
137 public function getWidth( $page = 1 ) {
138 return isset( $this->mInfo
['width'] ) ?
intval( $this->mInfo
['width'] ) : 0;
145 public function getHeight( $page = 1 ) {
146 return isset( $this->mInfo
['height'] ) ?
intval( $this->mInfo
['height'] ) : 0;
150 * @return bool|null|string
152 public function getMetadata() {
153 if ( isset( $this->mInfo
['metadata'] ) ) {
154 return serialize( self
::parseMetadata( $this->mInfo
['metadata'] ) );
160 * @param $metadata array
163 public static function parseMetadata( $metadata ) {
164 if( !is_array( $metadata ) ) {
168 foreach( $metadata as $meta ) {
169 $ret[ $meta['name'] ] = self
::parseMetadata( $meta['value'] );
175 * @return bool|int|null
177 public function getSize() {
178 return isset( $this->mInfo
['size'] ) ?
intval( $this->mInfo
['size'] ) : null;
182 * @return null|string
184 public function getUrl() {
185 return isset( $this->mInfo
['url'] ) ?
strval( $this->mInfo
['url'] ) : null;
189 * @param string $method
190 * @return int|null|string
192 public function getUser( $method='text' ) {
193 return isset( $this->mInfo
['user'] ) ?
strval( $this->mInfo
['user'] ) : null;
197 * @return null|string
199 public function getDescription() {
200 return isset( $this->mInfo
['comment'] ) ?
strval( $this->mInfo
['comment'] ) : null;
204 * @return null|String
207 return isset( $this->mInfo
['sha1'] )
208 ?
wfBaseConvert( strval( $this->mInfo
['sha1'] ), 16, 36, 31 )
213 * @return bool|Mixed|string
215 function getTimestamp() {
216 return wfTimestamp( TS_MW
,
217 isset( $this->mInfo
['timestamp'] )
218 ?
strval( $this->mInfo
['timestamp'] )
226 function getMimeType() {
227 if( !isset( $this->mInfo
['mime'] ) ) {
228 $magic = MimeMagic
::singleton();
229 $this->mInfo
['mime'] = $magic->guessTypesForExtension( $this->getExtension() );
231 return $this->mInfo
['mime'];
235 * @todo FIXME: May guess wrong on file types that can be eg audio or video
238 function getMediaType() {
239 $magic = MimeMagic
::singleton();
240 return $magic->getMediaType( null, $this->getMimeType() );
244 * @return bool|string
246 function getDescriptionUrl() {
247 return isset( $this->mInfo
['descriptionurl'] )
248 ?
$this->mInfo
['descriptionurl']
253 * Only useful if we're locally caching thumbs anyway...
254 * @param $suffix string
255 * @return null|string
257 function getThumbPath( $suffix = '' ) {
258 if ( $this->repo
->canCacheThumbs() ) {
259 $path = $this->repo
->getZonePath('thumb') . '/' . $this->getHashPath( $this->getName() );
261 $path = $path . $suffix . '/';
272 function getThumbnails() {
273 $dir = $this->getThumbPath( $this->getName() );
274 $iter = $this->repo
->getBackend()->getFileList( array( 'dir' => $dir ) );
277 foreach ( $iter as $file ) {
285 * @see File::purgeCache()
287 function purgeCache( $options = array() ) {
288 $this->purgeThumbnails( $options );
289 $this->purgeDescriptionPage();
292 function purgeDescriptionPage() {
293 global $wgMemc, $wgContLang;
295 $url = $this->repo
->getDescriptionRenderUrl( $this->getName(), $wgContLang->getCode() );
296 $key = $this->repo
->getLocalCacheKey( 'RemoteFileDescription', 'url', md5($url) );
298 $wgMemc->delete( $key );
302 * @param $options array
304 function purgeThumbnails( $options = array() ) {
307 $key = $this->repo
->getLocalCacheKey( 'ForeignAPIRepo', 'ThumbUrl', $this->getName() );
308 $wgMemc->delete( $key );
310 $files = $this->getThumbnails();
311 // Give media handler a chance to filter the purge list
312 $handler = $this->getHandler();
314 $handler->filterThumbnailPurgeList( $files, $options );
317 $dir = $this->getThumbPath( $this->getName() );
318 $purgeList = array();
319 foreach ( $files as $file ) {
320 $purgeList[] = "{$dir}{$file}";
323 # Delete the thumbnails
324 $this->repo
->quickPurgeBatch( $purgeList );
325 # Clear out the thumbnail directory if empty
326 $this->repo
->quickCleanDir( $dir );